Version: V4.0

Access Card Management API

Get Access Card List

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
access_card_id	String	Body	Access card ID
access_card_name	String	Body	Access card name
phone	String	Body	Phone
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
created_time	String	Body	Created time, UTC

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_card_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "access_card_name": "test",
      "access_card_id": "arbr2c4b070cc928496198944858b344f",
      "phone": "1234567",
      "start_time": "2025-04-16 13:32:45",
      "finish_time": "2025-04-17 13:32:45",
      "created_time": "2025-03-29 08:48:18"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Access Card Information

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
access_card_id	String	Body	Yes	Access card ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
access_card_name	String	Body	Access card name
phone	String	Body	Phone
rf_card_number	String	Body	RF card number
access_group_id	String	Body	Access group ID
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
created_time	String	Body	Created time, UTC

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_card_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_card_id": "arbr2c4b070cc928496198944858b344f"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "access_card_name": "test",
    "phone": "1234567",
    "rf_card_number": "123456",
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "start_time": "2025-04-16 13:32:45",
    "finish_time": "2025-04-17 13:32:45",
    "created_time": "2025-03-29 08:48:18"
  }
}

Failure Return Example

See Failure Return Example

Create Access Card Information

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
access_card_name	String	Body	Yes	Access card name
phone	String	Body	Yes	Phone
rf_card_number	String	Body	Yes	RF card number
access_group_id	String	Body	Yes	Access group ID
start_time	String	Body	Yes	Start time, UTC
finish_time	String	Body	Yes	Finish time, UTC

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
access_card_id	String	Body	Access card ID

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_access_card_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_card_name": "test",
    "phone": "1234567",
    "rf_card_number": "123456",
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "start_time": "2025-04-16 13:32:45",
    "finish_time": "2025-04-17 13:32:45"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_card_id": "a2a621c1ae77040d697bd2134700f57ea"
  }
}

Failure Return Example

See Failure Return Example

Update Access Card Information

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
access_card_id	String	Body	Yes	Access card ID
access_card_name	String	Body	Yes	Access card name
phone	String	Body	Yes	Phone
rf_card_number	String	Body	Yes	RF card number
access_group_id	String	Body	Yes	Access group ID
start_time	String	Body	Yes	Start time, UTC
finish_time	String	Body	Yes	Finish time, UTC

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_access_card_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_card_id": "a2a621c1ae77040d697bd2134700f57ea",
    "access_card_name": "test",
    "phone": "1234567",
    "rf_card_number": "123456",
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "start_time": "2025-04-16 13:32:45",
    "finish_time": "2025-04-17 13:32:45"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Delete Access Card Information

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
access_card_id	String	Body	Yes	Access card ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_access_card_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_card_id": "arbr2c4b070cc928496198944858b344f"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Get Access Group List

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
access_group_id	String	Body	Access group ID
access_group_name	String	Body	Access group name
created_time	String	Body	Created time, UTC

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_group_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "access_group_name": "test",
      "access_group_id": "arbr2c4b070cc928496198944858b344f",
      "created_time": "2025-03-29 08:48:18"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Access Group Information

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
access_group_id	String	Body	Yes	Access group ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
access_group_name	String	Body	Access group name
created_time	String	Body	Created time, UTC
residences	[]Object<residence>	Body	Residence information
public_access_groups	[]Object<public_access_group>	Body	Public access group information

residence description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID

public_access_group description

Parameter Name	Type	Location	Description
public_access_group_id	String	Body	Public access group ID

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_id": "arbr2c4b070cc928496198944858b344f"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "access_group_name": "test",
    "created_time": "2025-03-29 08:48:18",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ],
    "public_access_groups": [
      {
        "public_access_group_id": "a31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Failure Return Example

See Failure Return Example

Create Access Group Information

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
access_group_name	String	Body	Yes	Access group name
residences	[]Object<residence>	Body	Yes	Residence information
public_access_groups	[]Object<public_access_group>	Body	Yes	Public access group information

residence description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID

public_access_group description

Parameter Name	Type	Location	Required	Description
public_access_group_id	String	Body	Yes	Public access group ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
access_group_id	String	Body	Access group ID

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_name": "test",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ],
    "public_access_groups": [
      {
        "public_access_group_id": "a31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea"
  }
}

Failure Return Example

See Failure Return Example

Update Access Group Information

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
access_group_id	String	Body	Yes	Access group ID
access_group_name	String	Body	Yes	Access group name
residences	[]Object<residence>	Body	Yes	Residence information
public_access_groups	[]Object<public_access_group>	Body	Yes	Public access group information

residence description

Parameter Name	Type	Location	Required	Description
residence_id	String	Body	Yes	Residence ID

public_access_group description

Parameter Name	Type	Location	Required	Description
public_access_group_id	String	Body	Yes	Public access group ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_id": "a2a621c1ae77040d697bd2134700f57ea",
    "access_group_name": "test",
    "residences": [
      {
        "residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ],
    "public_access_groups": [
      {
        "public_access_group_id": "a31adc223cc4b3bedb6bd4742dedcfa52"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Delete Access Group Information

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
access_group_id	String	Body	Yes	Access group ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_access_group_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "access_group_id": "arbr2c4b070cc928496198944858b344f"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Get Public Access Group List

Request URL

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
public_access_group_id	String	Body	Public access group ID
public_access_group_name	String	Body	Public access group name
public_access_group_type	String	Body	Public access group type, system or customized
repeat_mode	String	Body	Repeat mode, never or daily or weekly
start_time	String	Body	Start time, UTC
finish_time	String	Body	Finish time, UTC
available_days	[]String	Body	Available days
user_count	Integer	Body	User count
created_time	String	Body	Created time, UTC

Request Example

POST /api/v1.0/invoke/open-ability/method/hotel-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_public_access_group_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": [
    {
      "public_access_group_name": "test",
      "public_access_group_id": "arbr2c4b070cc928496198944858b344f",
      "public_access_group_type": "system",
      "start_time": "00:00:00",
      "finish_time": "23:59:59",
      "repeat_mode": "daily",
      "available_days": [],
      "user_count": 0,
      "created_time": "2025-03-29 08:48:18"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get Access Card List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Access Card Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Create Access Card Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Update Access Card Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Delete Access Card Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Get Access Group List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Access Group Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

residence description​

public_access_group description​

Request Example​

Success Return Example​

Failure Return Example​

Create Access Group Information​

Request URL​

Request Parameter​

param description​

residence description​

public_access_group description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Update Access Group Information​

Request URL​

Request Parameter​

param description​

residence description​

public_access_group description​

Get Access Card List

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Access Card Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Create Access Card Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Update Access Card Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Delete Access Card Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Get Access Group List

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Access Group Information

Request URL

Request Parameter

param description

Return Parameter

result description

residence description

public_access_group description

Request Example

Success Return Example

Failure Return Example

Create Access Group Information

Request URL

Request Parameter

param description

residence description

public_access_group description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Update Access Group Information

Request URL

Request Parameter

param description

residence description

public_access_group description